Eclipse Platform
Pre-release 3.0

org.eclipse.team.ui.synchronize
Class TeamSubscriberParticipant

java.lang.Object
  extended byorg.eclipse.team.ui.synchronize.AbstractSynchronizeParticipant
      extended byorg.eclipse.team.ui.synchronize.TeamSubscriberParticipant
All Implemented Interfaces:
IExecutableExtension, ISynchronizeParticipant

public abstract class TeamSubscriberParticipant
extends AbstractSynchronizeParticipant

A synchronize participant that displays synchronization information for local resources that are managed via a TeamSubscriber.

Since:
3.0

Field Summary
static int ALL_MODES
           
static int BOTH_MODE
           
static int CONFLICTING_MODE
           
static int INCOMING_MODE
          Modes are direction filters for the view
static int OUTGOING_MODE
           
static String P_SYNCVIEWPAGE_LAYOUT
          Property constant indicating the mode of a page has changed.
static String P_SYNCVIEWPAGE_MODE
          Property constant indicating the mode of a page has changed.
static String P_SYNCVIEWPAGE_WORKINGSET
          Property constant indicating the mode of a page has changed.
static int TABLE_LAYOUT
          View type constant (value 1) indicating that the synchronize view will be shown as a table.
static int TREE_LAYOUT
          View type constant (value 0) indicating that the synchronize view will be shown as a tree.
 
Fields inherited from class org.eclipse.team.ui.synchronize.AbstractSynchronizeParticipant
configElement
 
Constructor Summary
TeamSubscriberParticipant()
           
 
Method Summary
 IPageBookViewPage createPage(ISynchronizeView view)
          Creates and returns a new page for this synchronize participant.
 void dispose()
          Disposes of this synchronize participant.
 org.eclipse.team.internal.ui.synchronize.sets.SubscriberInput getInput()
           
 int getLayout()
           
 int getMode()
           
 IWorkingSet getWorkingSet()
           
 void init(IMemento memento)
          Initializes this participant with the given participant state.
 void refreshWithRemote(IResource[] resources)
           
 void saveState(IMemento memento)
          Saves the participants object state within the memento.
 void setLayout(int layout)
           
 void setMode(int mode)
           
protected  void setSubscriber(TeamSubscriber subscriber)
           
 void setWorkingSet(IWorkingSet set)
           
 
Methods inherited from class org.eclipse.team.ui.synchronize.AbstractSynchronizeParticipant
addPropertyChangeListener, firePropertyChange, getId, getImageDescriptor, getName, removePropertyChangeListener, setImageDescriptor, setInitializationData, setInitializationData, setName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

P_SYNCVIEWPAGE_WORKINGSET

public static final String P_SYNCVIEWPAGE_WORKINGSET
Property constant indicating the mode of a page has changed.

See Also:
Constant Field Values

P_SYNCVIEWPAGE_MODE

public static final String P_SYNCVIEWPAGE_MODE
Property constant indicating the mode of a page has changed.

See Also:
Constant Field Values

INCOMING_MODE

public static final int INCOMING_MODE
Modes are direction filters for the view

See Also:
Constant Field Values

OUTGOING_MODE

public static final int OUTGOING_MODE
See Also:
Constant Field Values

BOTH_MODE

public static final int BOTH_MODE
See Also:
Constant Field Values

CONFLICTING_MODE

public static final int CONFLICTING_MODE
See Also:
Constant Field Values

ALL_MODES

public static final int ALL_MODES
See Also:
Constant Field Values

P_SYNCVIEWPAGE_LAYOUT

public static final String P_SYNCVIEWPAGE_LAYOUT
Property constant indicating the mode of a page has changed.

See Also:
Constant Field Values

TREE_LAYOUT

public static final int TREE_LAYOUT
View type constant (value 0) indicating that the synchronize view will be shown as a tree.

See Also:
Constant Field Values

TABLE_LAYOUT

public static final int TABLE_LAYOUT
View type constant (value 1) indicating that the synchronize view will be shown as a table.

See Also:
Constant Field Values
Constructor Detail

TeamSubscriberParticipant

public TeamSubscriberParticipant()
Method Detail

createPage

public IPageBookViewPage createPage(ISynchronizeView view)
Description copied from interface: ISynchronizeParticipant
Creates and returns a new page for this synchronize participant. The page is displayed for this synchronize participant in the given synchronize view.

Parameters:
view - the view in which the page is to be created
Returns:
a page book view page representation of this synchronize participant

setMode

public void setMode(int mode)

getMode

public int getMode()

setLayout

public void setLayout(int layout)

getLayout

public int getLayout()

setWorkingSet

public void setWorkingSet(IWorkingSet set)

getWorkingSet

public IWorkingSet getWorkingSet()

refreshWithRemote

public void refreshWithRemote(IResource[] resources)

dispose

public void dispose()
Description copied from interface: ISynchronizeParticipant
Disposes of this synchronize participant. This is the last method called on the ISynchronizeParticipant. It marks the end of the participants lifecycle.

Within this method a participant may release any resources, fonts, images, etc. held by this part. It is also very important to deregister all listeners.

Clients should not call this method (the synchronize manager calls this method at appropriate times).


getInput

public org.eclipse.team.internal.ui.synchronize.sets.SubscriberInput getInput()

setSubscriber

protected void setSubscriber(TeamSubscriber subscriber)

init

public void init(IMemento memento)
          throws PartInitException
Description copied from interface: ISynchronizeParticipant
Initializes this participant with the given participant state. A memento is passed to the participant which contains a snapshot of the participants state from a previous session.

This method is automatically called by the team plugin shortly after participant construction. It marks the start of the views's lifecycle. Clients must not call this method.

Specified by:
init in interface ISynchronizeParticipant
Overrides:
init in class AbstractSynchronizeParticipant
Throws:
PartInitException

saveState

public void saveState(IMemento memento)
Description copied from interface: ISynchronizeParticipant
Saves the participants object state within the memento. This state will be available when the participant is restored via init.

Specified by:
saveState in interface ISynchronizeParticipant
Overrides:
saveState in class AbstractSynchronizeParticipant

Eclipse Platform
Pre-release 3.0

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.